<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>IgH EtherCAT Master: EtherCAT Virtual TTY Interface</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">IgH EtherCAT Master
   &#160;<span id="projectnumber">1.5.2</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__TTYInterface.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">EtherCAT Virtual TTY Interface</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structec__tty__operations__t.html">ec_tty_operations_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Operations on the virtual TTY interface.  <a href="structec__tty__operations__t.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:gabf4bbf300a5c451d7fe82b65e17f097d"><td class="memItemLeft" align="right" valign="top">typedef struct ec_tty&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__TTYInterface.html#gabf4bbf300a5c451d7fe82b65e17f097d">ec_tty_t</a></td></tr>
<tr class="separator:gabf4bbf300a5c451d7fe82b65e17f097d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga64244c8ea384d633c3f8edfadeecffb3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TTYInterface.html#gabf4bbf300a5c451d7fe82b65e17f097d">ec_tty_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__TTYInterface.html#ga64244c8ea384d633c3f8edfadeecffb3">ectty_create</a> (const <a class="el" href="structec__tty__operations__t.html">ec_tty_operations_t</a> *ops, void *cb_data)</td></tr>
<tr class="memdesc:ga64244c8ea384d633c3f8edfadeecffb3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a virtual TTY interface.  <a href="#ga64244c8ea384d633c3f8edfadeecffb3">More...</a><br /></td></tr>
<tr class="separator:ga64244c8ea384d633c3f8edfadeecffb3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga03d764370f5d76bec71412ea1124a156"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__TTYInterface.html#ga03d764370f5d76bec71412ea1124a156">ectty_free</a> (<a class="el" href="group__TTYInterface.html#gabf4bbf300a5c451d7fe82b65e17f097d">ec_tty_t</a> *tty)</td></tr>
<tr class="memdesc:ga03d764370f5d76bec71412ea1124a156"><td class="mdescLeft">&#160;</td><td class="mdescRight">Releases a virtual TTY interface.  <a href="#ga03d764370f5d76bec71412ea1124a156">More...</a><br /></td></tr>
<tr class="separator:ga03d764370f5d76bec71412ea1124a156"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga71580e6fbab0aa678073c139bf516dae"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__TTYInterface.html#ga71580e6fbab0aa678073c139bf516dae">ectty_tx_data</a> (<a class="el" href="group__TTYInterface.html#gabf4bbf300a5c451d7fe82b65e17f097d">ec_tty_t</a> *tty, uint8_t *buffer, size_t size)</td></tr>
<tr class="memdesc:ga71580e6fbab0aa678073c139bf516dae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads data to send from the TTY interface.  <a href="#ga71580e6fbab0aa678073c139bf516dae">More...</a><br /></td></tr>
<tr class="separator:ga71580e6fbab0aa678073c139bf516dae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9d2e53ca7492e1a71a26cbbc7d51af52"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__TTYInterface.html#ga9d2e53ca7492e1a71a26cbbc7d51af52">ectty_rx_data</a> (<a class="el" href="group__TTYInterface.html#gabf4bbf300a5c451d7fe82b65e17f097d">ec_tty_t</a> *tty, const uint8_t *buffer, size_t size)</td></tr>
<tr class="memdesc:ga9d2e53ca7492e1a71a26cbbc7d51af52"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pushes received data to the TTY interface.  <a href="#ga9d2e53ca7492e1a71a26cbbc7d51af52">More...</a><br /></td></tr>
<tr class="separator:ga9d2e53ca7492e1a71a26cbbc7d51af52"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="gabf4bbf300a5c451d7fe82b65e17f097d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabf4bbf300a5c451d7fe82b65e17f097d">&#9670;&nbsp;</a></span>ec_tty_t</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef struct ec_tty <a class="el" href="group__TTYInterface.html#gabf4bbf300a5c451d7fe82b65e17f097d">ec_tty_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="section see"><dt>See also</dt><dd>ec_tty </dd></dl>

<p class="definition">Definition at line <a class="el" href="ectty_8h_source.html#l00052">52</a> of file <a class="el" href="ectty_8h_source.html">ectty.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga64244c8ea384d633c3f8edfadeecffb3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga64244c8ea384d633c3f8edfadeecffb3">&#9670;&nbsp;</a></span>ectty_create()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TTYInterface.html#gabf4bbf300a5c451d7fe82b65e17f097d">ec_tty_t</a>* ectty_create </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structec__tty__operations__t.html">ec_tty_operations_t</a> *&#160;</td>
          <td class="paramname"><em>ops</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>cb_data</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Create a virtual TTY interface. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ops</td><td>Set of callbacks. </td></tr>
    <tr><td class="paramname">cb_data</td><td>Arbitrary data, that is passed to any callback.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Pointer to the interface object, otherwise an ERR_PTR value. </dd></dl>

</div>
</div>
<a id="ga03d764370f5d76bec71412ea1124a156"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga03d764370f5d76bec71412ea1124a156">&#9670;&nbsp;</a></span>ectty_free()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ectty_free </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__TTYInterface.html#gabf4bbf300a5c451d7fe82b65e17f097d">ec_tty_t</a> *&#160;</td>
          <td class="paramname"><em>tty</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Releases a virtual TTY interface. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">tty</td><td>TTY interface. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga71580e6fbab0aa678073c139bf516dae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga71580e6fbab0aa678073c139bf516dae">&#9670;&nbsp;</a></span>ectty_tx_data()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned int ectty_tx_data </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__TTYInterface.html#gabf4bbf300a5c451d7fe82b65e17f097d">ec_tty_t</a> *&#160;</td>
          <td class="paramname"><em>tty</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t *&#160;</td>
          <td class="paramname"><em>buffer</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>size</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Reads data to send from the TTY interface. </p>
<p>If there are data to send, they are copied into the <em>buffer</em>. At maximum, <em>size</em> bytes are copied. The actual number of bytes copied is returned.</p>
<dl class="section return"><dt>Returns</dt><dd>Number of bytes copied. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">tty</td><td>TTY interface. </td></tr>
    <tr><td class="paramname">buffer</td><td>Buffer for data to transmit. </td></tr>
    <tr><td class="paramname">size</td><td>Available space in <em>buffer</em>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga9d2e53ca7492e1a71a26cbbc7d51af52"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9d2e53ca7492e1a71a26cbbc7d51af52">&#9670;&nbsp;</a></span>ectty_rx_data()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ectty_rx_data </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__TTYInterface.html#gabf4bbf300a5c451d7fe82b65e17f097d">ec_tty_t</a> *&#160;</td>
          <td class="paramname"><em>tty</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const uint8_t *&#160;</td>
          <td class="paramname"><em>buffer</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>size</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Pushes received data to the TTY interface. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">tty</td><td>TTY interface. </td></tr>
    <tr><td class="paramname">buffer</td><td>Buffer with received data. </td></tr>
    <tr><td class="paramname">size</td><td>Number of bytes in <em>buffer</em>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>
